home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / bbs_util / ezvote50.zip / EZVOTE.DOC < prev    next >
Text File  |  1994-07-23  |  9KB  |  198 lines
  1.  
  2.  
  3.  
  4.                 ─────────────────────────────────────────────
  5.                                  EZVote 5.00
  6.                            "The user polling door"
  7.  
  8.                 (C) Copyright 1991, 1992, 1994 by Brian Pirie
  9.                 ─────────────────────────────────────────────
  10.  
  11.  
  12.           EZVote is a user voting door for your BBS, that allows
  13.     users to create "polls" for other users to vote on. EZVote is very
  14.               easy to setup and use, and is absoloutely free!
  15.  
  16.        EZVote is highly configurable, allowing you to provide your own
  17.        menu screen, specify whether or not users should be permitted to
  18.         add their own questions, set maximum time limits for the door,
  19.                      and customize many other options.
  20.  
  21.         EZVote permits up to 200 questions to be created, and voted on
  22.                             by up to 30,000 users.
  23.  
  24.         EZVote graphically displays the results of voting on questions.
  25.  
  26.          EZVote can be run under most bulletin board software packages.
  27.  
  28.                       EZVote is fully multi-node capable.
  29.  
  30.            The EZVote package includes the C source code for EZVote.
  31.  
  32.             EZVote was previously distributed under the name RAVote.
  33.  
  34.  
  35.  
  36.  
  37.        ┌─ SETTING UP EZVOTE ─┐
  38.        └─────────────────────┘
  39.  
  40.                In general, you can setup EZVote to run under your
  41.        bulletin board software by copying the contents of the EZVote
  42.        archive in your BBS software's system directory. Then setup your
  43.        BBS software to start the EZVOTE.EXE file as you would setup any
  44.        door program.
  45.  
  46.                A wide variety of EZVote options can be configured by
  47.        editing the EZVOTE.CFG file. This file is fully self-documenting,
  48.        explaining the use and purpose of each setting.
  49.  
  50.  
  51.        ┌─ RUNNING EZVOTE ─┐
  52.        └──────────────────┘
  53.  
  54.                The EZVote door behaves similarly to most other door
  55.        programs. What you see in the output window is identical to what
  56.        the user on remote will be seeing. If the user has
  57.        ANSI/AVATAR/RIP mode turned on, you will see the same colors as
  58.        they do, and if they have screen clearing turned on, your screen
  59.        will clear when their's does. The status line at the bottom of
  60.        the screen will list the name of the user currently on-line (if
  61.        you're using the sample DORINFO1.DEF file, the user's name will
  62.        be "The Sysop"), the user's location, and the user's baud rate (0
  63.        if the door is operating in local mode). You will also be told
  64.        how much time the user has left, and there will be indicators as
  65.        to whether the user has ANSI mode on, etc. If the user wishes to
  66.        Chat with the sysop (ie, they have paged the sysop, but haven't
  67.        had a response yet), a [Want-Chat] indicator will be flashing on
  68.        the status line. The following function keys are available only
  69.        to the sysop:
  70.  
  71.               []/[] - Use the arrow keys to increase or decrease how
  72.                         much time the user has left in the door.
  73.  
  74.             [Alt]-[C] - Allows the sysop to break into chat with the
  75.                         user at any time. [Alt]-[C] again, or [ESC] will
  76.                         end chat mode. (notice that the Want-Chat
  77.                         indicator will be turned off if it was flashing
  78.                         too. If your door is running under RemoteAccess
  79.                         or QuickBBS, paging from within the door will
  80.                         even cause the Want-Chat indicator to stay lit
  81.                         when the user returns to the BBS)
  82.  
  83.             [Alt]-[J] - Allows the sysop to shell to DOS, if enough
  84.                         memory is available. Simply type EXIT to return
  85.                         to the door again.
  86.  
  87.             [Alt]-[H] - Hangup on the user. When the sysop does this,
  88.                         OpenDoors will optionally call a function you
  89.                         have indicated in the OpenDoors control
  90.                         structure, to allow you to close files, etc.
  91.                         OpenDoors will then exit to a batch file with
  92.                         the appropriate errorlevel:
  93.  
  94.                               0 - A critical error has occurred
  95.                               1 - Carrier lost, user off-line
  96.                               2 - Sysop terminated call, user off-line
  97.                               3 - User time used up, user STILL ON-LINE
  98.                               4 - Keyboard inactivity timeout, user
  99.                                   off-line
  100.                           5-255 - Defined by your door
  101.  
  102.                         These errorlevel will allow users of your door
  103.                         to optionally log the user back on-line, place
  104.                         the BBS in "wait for call" mode, or whatever
  105.                         they wish, depending on how the door exited
  106.  
  107.             [Alt]-[K] - The "User Keyboard-Off" key, will allow the
  108.                         sysop to temporarily prevent the user from
  109.                         typing anything on his keyboard. This has no
  110.                         effect on the local keyboard, but causes
  111.                         OpenDoors to ignore any keystrokes from remote.
  112.  
  113.             [Alt]-[N] - The "Sysop Next" key, this function reserves the
  114.                         system for use by the sysop after the user logs
  115.                         off, if the door is running under an RA 1.00 or
  116.                         compatible system.
  117.  
  118.             [Alt]-[D] - "Drop to BBS" key. This function allows the sysop
  119.                         to exit the door and return the user to the BBS,
  120.                         without hanging up.
  121.  
  122.  
  123.        ┌─ USER CHOICES FROM WITHIN EZVOTE ─┐
  124.        └───────────────────────────────────┘
  125.  
  126.                When running the EZVote program the user may choose the
  127.         following choices from the menu:
  128.  
  129.            Vote on A Question - This allows the user to vote on a
  130.                    question that has been created by another user, which
  131.                    they have not already answered. The user may add
  132.                    their own choice to the poll by choosing the "Other"
  133.                    command and adding another answer to the question, if
  134.                    this feature was enabled when the question was
  135.                    created.
  136.  
  137.            View Results - This allows the user to see the results of any
  138.                    of the polls that they have already voted on. EZVote
  139.                    will list the percentage of users who have voted on
  140.                    each topic, along with a small graph representing
  141.                    each option's popularity. You can also configure
  142.                    EZVote to allow users to see the results of questions
  143.                    regarless of whether or not they have voted on the
  144.                    question. To do this, set ViewUnvoted to Yes in the
  145.                    EZVOTE.CFG configuration file.
  146.  
  147.            Add a Question - This allows the user to create their own
  148.                    poll for other users to vote on. They will be able to
  149.                    enter the question, possible answers, and choose
  150.                    whether or not votees will be able to add their own
  151.                    answers.
  152.  
  153.            Page Sysop - This allows the user to page the sysop for chat.
  154.                    Sysop paging hours are set in the EZVOTE.CFG
  155.                    configuration file.
  156.  
  157.            Exit Door - This command will return the user to the BBS.
  158.  
  159.            Hangup - This command will log the user off of the BBS
  160.  
  161.            Delete Question - This command, which is ONLY available to the
  162.                    SYSOP will allow certain topics to be deleted (say
  163.                    those which are old or in bad taste.)
  164.  
  165.  
  166.        Note: You may create your own menu for EZVote by creating the
  167.        files EZVOTE.ASC/EZVOTE.ANS/EZVOTE.AVT/EZVOTE.RIP.
  168.  
  169.  
  170.        ┌─ SOURCE CODE ─┐
  171.        └───────────────┘
  172.  
  173.                Included in this archive is the source code for EZVote.
  174.        If you wish to recompile any changes that you make to the EZVote
  175.        source code, you must have a copy of OpenDoors, the door
  176.        programming toolkit that EZVote is written with. OpenDoors is a
  177.        complete library for C programmers using compilers from Borland
  178.        and Microsoft. OpenDoors handles all of the details of door
  179.        programming for you, to allow you to concentrate on the door
  180.        itself. If you would like the newest copy of OpenDoors, feel free
  181.        to request ODOORS*.* from 1:243/8, or log onto the BBS at +1 613
  182.        526 4466.
  183.  
  184.  
  185.        ┌─ CONTACTING THE AUTHOR ─┐
  186.        └─────────────────────────┘
  187.  
  188.                If you wish to contact me for any reason, I can be
  189.         reached by any of the means listed below:
  190.  
  191.            Internet email : brian@bpecomm.ocunix.on.ca
  192.           FidoNet netmail : 1:243/8 (you must poll for a response)
  193.               Modem (BBS) : +1 613 526 4466
  194.         Conventional Mail : Brian Pirie
  195.                             #1416 - 2201 Riverside Drive
  196.                             Ottawa, Ontario
  197.                             K1H 8K9
  198.